home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Ham Radio 2000
/
Ham Radio 2000.iso
/
ham2000
/
logs
/
logem20
/
logem.doc
< prev
next >
Wrap
Text File
|
1994-11-29
|
20KB
|
530 lines
Log'Em Version 2.0 Program Documentation.
Written By: Jim Johnson [N7XTY].
(C) Copyright 1992, 1993.
All Rights Reserved.
Documentation Contents
Shareware Agreement........................ 1
Disclaimer................................. 1
File Information........................... 1
Setup / Quick Start........................ 2
TSR Opening Screen......................... 2
TSR Log'Em and Standard Log'Em............. 2
Log'Em Menu................................ 2
[A] Add a New Contact.................... 2
[F] Find a Contact....................... 3
[I] Program Information.................. 3
[X] Exit Program......................... 3
[P] Print Entire Logbook................. 3
[V] View (Browse) Logbook................ 3
Utility Program............................ 4
Using the Utility Program.................. 4
[C] Print a Specified Call Area.......... 4
[V] View a Specified Call Area........... 4
[I] Initalize Log'Em Files............... 5
[P] Purge Logbook........................ 5
[M] Print a Specified Mode............... 5
[S] View a Specified Mode................ 5
[E] Print Entire Logbook................. 5
[L] View (Browse) Logbook................ 5
[R] Read Documentation................... 5
[X] Exit Program......................... 6
Other Notes................................ 6
Thank You.................................. 6
Source Code................................ 6
Log'Em 2.0 Documentation. i
SHAREWARE AGREEMENT.
====================
Log'Em Version 2.0 is being released as SHAREWARE software which
grants you a limited license to use, copy and distribute Log'Em
and it's companion files and documentation in their original and
unmodified form only. You may not sell any part of this program
for profit without the expressed written consent of Jim Johnson.
The limited license grants you use of this program for a period
of, not to exceed 30 days for evaluation purposes. After the 30
day evaluation period if you decide to keep this software and/or
use this software you are required to send a registration fee of
$25 to the address below.
Log'Em is written in Turbo Pascal Version 6.0 and is completely
rewritten from Log'Em version 1.0.
DISCLAIMER.
===========
Jim Johnson shall not be held liable for any damages that may
arise from the use of this program including but, not limited
to, loss of data, loss of wages, damage to other software or
hardware. You as the user of this program are completely and
soley responsible for any such damage that may occur by using
this program. By your continued use of this software you are
in fact stating that you agree to the terms of the shareware
agreement and the terms of the disclaimer. This software is
provided "as-is" with out warranty of any kind.
Please send all correspondence to:
Jim Johnson
P.O. Box 6352
Kennewick, Wa. 99336-0352
The original files and sizes of the file are shown below. If any
of the files you have differ from the ones below, BEFORE using this
program, your copy of the files are not original and I would suggest
you don't use them. Before you use the program yor files should be:
LOGEM.EXE 14656 bytes 11/30/94 12:00a
LOGEM2.EXE 10800 bytes 11/30/94 12:00a
LOG-UTIL.EXE 46262 bytes 11/30/94 12:00a
UTIL.BAT 42 bytes 11/30/94 12:00a
CAPSON.EXE 3424 bytes 11/30/94 12:00a
CAPSOFF.EXE 3424 bytes 11/30/94 12:00a
LOGEM.DOC 19560 bytes 11/30/94 12:00a
READ.ME 107 bytes 11/30/94 12:00a
LOGEM.EXE - TSR Version of Log'Em 2.0.
LOGEM2.EXE - Version 2.0 of Log'Em, non-TSR.
LOG-UTIL.EXE - Utility and Support program for Log'Em 2.0.
UTIL.BAT - Batch file to start LOG-UTIL.EXE.
CAPSON.EXE - Automatically sets Caps Lock.
CAPSOFF.EXE - Turns Caps Lock off.
LOGEM.DOC - Documentation file (This File).
Log'Em 2.0 Documentation. Page 1
Log'Em Setup and Quick Start.
=============================
Unzip LOGEM-II.ZIP or copy the program files into your TNC's program
directory. The files must be run from the current directory or you
can modify your autoexec.bat file to include the Log'Em directory in
your path statement and set the Log'Em program with the SET command.
Refer to your DOS manual for these procedures.
Run the Log'Em utility by typing UTIL and press return at the DOS
prompt. The utility program will display a menu, choose 'I' from
the options provided and press return. This will initalize the
contact log, and enter the first entry. After the initalization
takes place the logging program will be ready to use.
TSR Log'Em Opening Screen.
==========================
When you start the TSR Log'Em program you will see the following.
Log'Em Version 2.0 is now installed in memory.
<Alt> and the numeric keypad <+> key to activate.
==========================================================================
LOGEM/R = Remove from Memory LOGEM/H = Halt Execution LOGEM/RE = Restart
The commands under the dashed line are executable from the DOS prompt.
LOGEM/R will remove Log'Em from memory, freeing up the RAM it used.
LOGEM/H will halt Log'Ems execution, if needed.
LOGEM/RE will restart Log'Em after a /H command or will restart and
freshen the program in memory.
After issuing a halt (/H) command you must restart (/RE) Log'Em to
use it again.
TSR Log'Em and Standard Log'Em.
===============================
The following section applies to both LOGEM2.EXE (The TSR Log'Em
program) and LOGEM.EXE (The standard or non-TSR Log'Em program).
The program menu is layed out as below, and a detailed description
of the menu options follow.
[A] Add a New Contact [P] Print Entire Logbook
[F] Find a Contact [V] View Entire Logbook
[I] Program Information [X] Exit Log'Em
[A] Add a New Contact.
----------------------
Choosing this option from the main menu will allow you to enter
a new contact into the logbook. You will be prompted to enter the
callsign of the station, date of contact, time of contact (UTC),
frequency of the contact (MHz), signal report information, mode of
the contact and the operators name.
Log'Em 2.0 Documentation Page 2
Upon entering the information it will be displayed on the screen
just as you entered it, and then you will be asked to confirm the
addition of the contact to the logbook. If you answer 'Y' the new
contact information will be saved to the file CONTACT.LOG. Note -
All new entries in the logbook are added to the end of the file, as
if you were still using the hand written log. Once the contact is
saved you will be returned to the main menu. If you answer 'N' to
the save contact prompt the information will be forgotten and you
will be returned to the main menu.
[F] Find a Contact.
-------------------
Entering 'F' at the main menu and pressing return will start the
subroutine to find a contact in the logbook. You will be asked
to enter the callsign of the station to find. If the contact
record exists it will be displayed on the screen in the following
manner.
Call Date UTC MHz RST Mode Name
---------------------------------------------------------------------
N7XTY 12/29/92 1305Z 7.035 599 SSB Jim Johnson
After the record is found and displayed you will see a 'Press Return'
prompt. When you have the information you wanted, just press return
and you will be taken back to the main menu.
If the contact record does not exist, you will be informed of such
and asked to press return to continue.
[I] Program Information.
------------------------
Choosing 'I' from the main menu will display a screen of information
on Log'Em 2.0 including a basic shareware statement. Once you have
finished reading the text on your screen just press return and you
will be taken back to the main menu.
[X] Exit Program.
-----------------
Choosing 'X' at the main menu will stop program execution and drop
you to DOS, if using he standard program, and return you to DOS or
the other running application if using the TSR program.
[P] Print Entire Logbook.
-------------------------
If you want to print the entire logbook on the printer, choose 'P'
at the main menu command prompt. The screen will clear, and you
will be told that the printing is taking place. The printer must
be turned on and ready to go otherwise, and error will occur and
the logbook will not be printed. After the logbook is finished
printing you will be taken back to the main menu.
[V] View Entire Logbook.
------------------------
This option from the main menu will display the entire logbook on
the screen, with automatic breaking when the screen is full. To
continue with the display of the log just press return. When the
log is completed being displayed, pressing return again will take
you to the main menu.
Log'Em 2.0 Documentation. Page 3
Log'Em's Utility Program.
=========================
In order to keep the size of the TSR Log'Em program down, and to use
as little RAM as possible, I wrote the basic logging program in TSR
and standard form and wrote the utility program for some other and
more involved features.
The utility program will not go into memory, and can not be called
by either the TSR or standard logging programs.
Using the Utility program.
--------------------------
Start the utility program with the batch file provided, UTIL.BAT.
The batch file will set up the computer with it's caps lock function
on as the program requires capital letters for some of the inputs.
I decided to do this in order to keep the size of the program down,
and the log data file down.
The utility program will present you with a menu like the following.
[C] Print a Specified Call Area
[V] View a Specified Call Area
[I] Initalize Log'Em files
[P] Purge Logbook
[M] Print a Specified Mode
[S] View a Specified Mode
[E] Print the Entire Logbook
[L] View Entire Logbook
[R] Read Documentation
[X] Exit Program
[C] Print a Specified Call Area.
--------------------------------
This menu option will print on the printer all of the logged calls
from a specific call area. You will be prompted to enter the call
area to print. At this prompt, enter the NUMBER of the area you
want to be printed. For instance, if you wanted a listing of all
the stations in your log from the call area 7, enter the digit 7 and
only those calls will be printed.
The program will only search for calls that are 1 by, or 2 by (i.e.
x7xx, x7xxx, xx7xxx.) I don't know if any overseas countries are
using any other form(s) of callsigns, at least those I have been in
contact with do not. Corrections to my knowledge on this will be
welcomed!
[V] View a Specified Call Area.
-------------------------------
This is exactly the same as the 'C' option with the exception that
the data will be listed on the screen instead of the printer. An
automatic pause feature is also built in to stop output when the
screen is full. You also have the option of quitting this function
by entering 'Q' at the Press Return prompt.
Log'Em 2.0 Documentation. Page 4
[I] Initalize Log'Em Files.
---------------------------
This option should only be used when first installing Log'Em onto
your system, or if you are restarting your log.
CAUTION!! THIS FUNCTION WILL ERASE AND OVER WRITE ANY EXISTING LOG
BOOK YOU HAVE ON THE DISK OR IN THE SAME DIRECTORY WITH THE NAME OF
"CONTACT.LOG", USE THIS OPTION WITH CARE!!
[P] Purge Logbook.
------------------
Purging the logbook will take you entry by entry through the entire
logbook, which if large, will take a while to complete. Upon your
request to purge the log you will be given three options after each
entry is displayed, Update, Delete or Keep.
Update - You will be prompted to enter all new information for this
contact record. Once finished your entries will be displayed
in the logbook form, and you will be asked to confirm the
changes.
Delete - Choosing Delete will erase the contact record from the
log book.
Keep - To save the record being displayed 'as-is', press 'K' at
the option prompt. The record will be kept intact.
[M] Print a Specified Mode.
---------------------------
This is similiar to printing a specified call area, except that the
contacts you wish to print are determined by the mode of operation,
FM, CW, SSB, RTTY, etc,.....
[S] View a Specified Mode.
--------------------------
This is the same as printing a specified mode with the output being
displayed on the screen instead of the printer. Again you will have
the option to quit the function by pressing 'Q' at the Press Return
prompt.
[E] Print the Entire Log.
-------------------------
Pretty self explanitory....it will print on the printer every call
you have logged in the log book.
[L] View Logbook.
-----------------
This is the same as print the entire logbook option, again with the
exception that the output will be on the monitor instead of the
printer and you have the option the quit at the press return prompt.
[R] Read Documentation.
-----------------------
This option will display the documentation file (this file) on the
monitor screen. Output will stop every screen full and may be
continued by pressing return or halted by entering 'Q' and pressing
return.
Log'Em 2.0 Documentation. Page 5
[X] Exit Program.
-----------------
Exits the Utility program and returns you to DOS.
OTHER NOTES:
============
The TSR (Terminate - Stay Resident) logbook program may or may not
restore the screen when you exit or return to your TNC or other
program that you are using for communications. I have tried the
TSR program on several various programs and the screen restoration
was about half and half. It did not interfer with the operation of
the running software, it is just that I had to freshen the screen
manually. I will be working on this slight problem for future or
updated versions of Log'Em.
Thank You.
----------
I would like to take the opportunity to thank Mr. Hildred Freeman,
AA4EN for his views, comments and suggestions on the first version
of Log'Em. Your suggestions and comments played a major part in the
writing of version 2.0 and will continue to be implemented in any
updated or new version that I may write. I appreciate you detailed
'vision' of a logging program and the time you took to share it with
me.
Source Code.
------------
I have to admit that the source code is not completely mine, only
about 95% of it is. I would like to give credit where the credit is
due however, the TSR code I found on a local Telephone Bulletin
Board System does not give the authors name. The file was called
TSR_UNIT.ZIP and gives no information on author or code so, who ever
wrote it, Thank You for the basic's of tsr routines. I modified the
TSR code into a workable TSR program and then implemented it to work
with my program, Log'Em. The rest of the code is mine, written from
scratch with some frustration and sweat.
I have thought long and hard about releasing the source code, and
have decided that I will offer it to who ever would like a copy of
it for a fee of $50. My reasoning for the fee is that I have spent
hours upon hours sitting at this computer, working out routines and
functions, debugging the code, and modifing code to become what you
see in the program. I have invested well over 50 hours on this
program alone, and have determined that my time is worth something.
If you figure my time into my fee for the code, it is less that $1
an hour. Another reason I choose that amount for a fee is to weed
out the serious programmers, from those that just want to hack at
the code and claim it as theirs.
Log'Em 2.0 Documentation. Page 6